/*
 *  Copyright (c) 2001 Sun Microsystems, Inc.  All rights
 *  reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *  1. Redistributions of source code must retain the above copyright
 *  notice, this list of conditions and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright
 *  notice, this list of conditions and the following disclaimer in
 *  the documentation and/or other materials provided with the
 *  distribution.
 *
 *  3. The end-user documentation included with the redistribution,
 *  if any, must include the following acknowledgment:
 *  "This product includes software developed by the
 *  Sun Microsystems, Inc. for Project JXTA."
 *  Alternately, this acknowledgment may appear in the software itself,
 *  if and wherever such third-party acknowledgments normally appear.
 *
 *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
 *  not be used to endorse or promote products derived from this
 *  software without prior written permission. For written
 *  permission, please contact Project JXTA at http://www.jxta.org.
 *
 *  5. Products derived from this software may not be called "JXTA",
 *  nor may "JXTA" appear in their name, without prior written
 *  permission of Sun.
 *
 *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *  DISCLAIMED.  IN NO EVENT SHALL SUN MICROSYSTEMS OR
 *  ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 *  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 *  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 *  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 *  SUCH DAMAGE.
 *  ====================================================================
 *
 *  This software consists of voluntary contributions made by many
 *  individuals on behalf of Project JXTA.  For more
 *  information on Project JXTA, please see
 *  <http://www.jxta.org/>.
 *
 *  This license is based on the BSD license adopted by the Apache Foundation.
 *
 *  $Id: ModuleClassAdv.java,v 1.2 2005/05/24 02:39:55 hamada Exp $
 */
package net.jxta.impl.protocol;

import java.net.URI;
import java.util.Enumeration;
import java.net.URISyntaxException;
import java.net.MalformedURLException;
import java.net.UnknownServiceException;

import org.apache.log4j.Level;
import org.apache.log4j.Logger;

import net.jxta.protocol.ModuleClassAdvertisement;
import net.jxta.platform.ModuleClassID;
import net.jxta.id.IDFactory;
import net.jxta.document.*;

/**
 *  Description of the Class
 */
public class ModuleClassAdv extends ModuleClassAdvertisement {

    /**
     *  Log4J Logger
     */
    private final static Logger LOG = Logger.getLogger(ModuleClassAdv.class.getName());

    /**
     *  Constructor for the ModuleClassAdv object
     */
    public ModuleClassAdv() {
        // set defaults
        setDescription(null);
        setName(null);
        setModuleClassID(null);

    }

    /**
     *  Constructor for the ModuleClassAdv object
     *
     *@param  root  Description of the Parameter
     */
    public ModuleClassAdv(Element root) {
        if (!XMLElement.class.isInstance(root)) {
            throw new IllegalArgumentException(getClass().getName() + " only supports XLMElement");
        }

        XMLElement doc = (XMLElement) root;

        String doctype = doc.getName();

        String typedoctype = "";
        Attribute itsType = doc.getAttribute("type");
        if (null != itsType) {
            typedoctype = itsType.getValue();
        }

        if (!doctype.equals(getAdvertisementType()) && !getAdvertisementType().equals(typedoctype)) {
            throw new IllegalArgumentException("Could not construct : "
                     + getClass().getName() + "from doc containing a " + doc.getName());
        }

        Enumeration elements = doc.getChildren();

        while (elements.hasMoreElements()) {
            XMLElement elem = (XMLElement) elements.nextElement();

            if (!handleElement(elem)) {
                if (LOG.isEnabledFor(Level.DEBUG)) {
                    LOG.debug("Unhandled Element: " + elem.toString());
                }
            }
        }

        // Sanity Check!!!

    }

    /**
     *  {@inheritDoc}
     *
     *@param  encodeAs  Description of the Parameter
     *@return           The document value
     */
    public Document getDocument(MimeMediaType encodeAs) {
        StructuredDocument adv = (StructuredDocument) super.getDocument(encodeAs);

        Element e;

        e = adv.createElement(idTag, getModuleClassID().toString());
        adv.appendChild(e);

        e = adv.createElement(nameTag, getName());
        adv.appendChild(e);

        String description = getDescription();
        if (null != description) {
            e = adv.createElement(descTag, description);
            adv.appendChild(e);
        }

        return adv;
    }

    /**
     *  {@inheritDoc}
     *
     *@return    The indexFields value
     */
    public final String[] getIndexFields() {
        return fields;
    }

    /**
     *  {@inheritDoc}
     *
     *@param  raw  Description of the Parameter
     *@return      Description of the Return Value
     */
    protected boolean handleElement(Element raw) {

        if (super.handleElement(raw)) {
            return true;
        }

        XMLElement elem = (XMLElement) raw;

        if (elem.getName().equals(nameTag)) {
            setName(elem.getTextValue());
            return true;
        }

        if (elem.getName().equals(descTag)) {
            setDescription(elem.getTextValue());
            return true;
        }

        if (elem.getName().equals(idTag)) {
            try {
                URI clID = new URI(elem.getTextValue());
                setModuleClassID((ModuleClassID) IDFactory.fromURI(clID));
            } catch (URISyntaxException badID) {
                throw new IllegalArgumentException("Bad pipe ID in advertisement");
            } catch (ClassCastException badID) {
                throw new IllegalArgumentException("Unusable ID in advertisement");
            }
            return true;
        }

        return false;
    }

    /**
     *  Description of the Class
     */
    public static class Instantiator implements AdvertisementFactory.Instantiator {

        /**
         *  {@inheritDoc}
         *
         *@return    The advertisementType value
         */
        public String getAdvertisementType() {
            return ModuleClassAdvertisement.getAdvertisementType();
        }

        /**
         *  {@inheritDoc}
         *
         *@return    Description of the Return Value
         */
        public Advertisement newInstance() {
            return new ModuleClassAdv();
        }

        /**
         *  {@inheritDoc}
         *
         *@param  root  Description of the Parameter
         *@return       Description of the Return Value
         */
        public Advertisement newInstance(net.jxta.document.Element root) {
            return new ModuleClassAdv(root);
        }
    }
}

